docs(readme): add vhs demo GIF - #2
Merged
Merged
Conversation
Show the four-command flow (generate → find → query → install claude) in one 25s recording so the README leads with what the tool does rather than describing it. Track demo sources (schema, overlays, .dbmlgraph.yml, demo.tape) plus the rendered demo.gif; ignore the generated graph/, .claude/, and AGENTS.md that `vhs demo.tape` produces on each run. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the demo recording to the README so the landing page leads with what the tool does rather than describing it.
What's in it
A 25s vhs recording of the four-command flow against a small sample e-commerce schema:
dbmlgraph generate— DBML + overlay → markdown knowledge graphdbmlgraph find promo_id— identifier lookup across tables/columns/enumsdbmlgraph query orders— context pack for one table + neighborsdbmlgraph install claude— wire the graph into an AI agentChanges
README.md— GIF embed below the intro paragraph, with a caption pointing at the tape source and the regenerate commanddemo/— tracked sources (schema.dbml,overlays/,.dbmlgraph.yml,demo.tape) plus the rendereddemo.gif(745 KB).gitignore— ignoredemo/graph/,demo/.claude/, anddemo/AGENTS.md, whichvhs demo.taperegenerates on every runNotes
raw.githubusercontent.comURL so it also renders on the npm package page. That means it 404s until this branch merges tomain— expected, not a broken commit.demo/is excluded from the npm tarball already (package.jsonfilesis["dist"]), so the published package size is unchanged.npm run build && cd demo && vhs demo.tape.🤖 Generated with Claude Code